v1.68.1

Compare Source

gRPC Java 1.68.1 Release Notes

v1.68.0 was a mistake. This is the first release of version 1.68.x

Bug Fixes

• xds: Fix NullPointerException introduced in "Fix load reporting when pick first is used for locality-routing" (#​11553). This was in 1.67.1 but not 1.68.0

Behavior Changes

• core: JSON parsing rejects duplicate keys in objects (#​11575) (4be69e3). This is the existing behavior in C core. Duplicate keys in objects are dangerous as which value takes effect is undefined. Previously, the last value was used
• okhttp: Detect transport executors with no remaining threads (#​11503) (3a6be9c). The transport uses two threads, but one is on-demand. If the executor provided to builder.transportExecutor() runs out of threads (e.g., it is a fixed-size thread pool), all transports can be wedged, unable to run on-demand tasks, until keepalive kills one of them. Two threads are now used when handshaking a new transport, and the transport will time out after 1 second with “Timed out waiting for second handshake thread” if two threads are unavailable
• gcp-csm-o11y: Get mesh_id value from CSM_MESH_ID environment variable, instead of getting it from bootstrap file (84d30af)

Improvements

• New grpc-context-override-opentelemetry artifact (#​11523) (782a44a) (#​11599) (e59ae5f). This is a io.grpc.Context storage override to store its state in io.opentelemetry.context.Context. Libraries should not add a dependency on this artifact, as applications can only have one storage override in their classpath
• New grpc-s2a artifact. It is a transport that offloads the handshake similar to ALTS, but for TLS. It provides io.grpc.s2a.S2AChannelCredentials
• api: Enhance name resolver `ResolutionResult` to hold addresses or error so the single listener API onResult2 is used to convey both success and error cases for name resolution (#​11330) (1ded8af)
• core: Handle NameResolver/LoadBalancer exceptions when panicking (b692b9d). This expands the class of bugs that will fail RPCs with the panic error, versus some undefined behavior
• core: Use the default service config in case of initial name resolver address resolution error (#​11577) (fa26a8b)
• core: StreamTracer.inboundMessageRead() now reports uncompressed message size when the message does not need compression (#​11598) (2aae68e). Previously it always reported -1 (unknown)
• netty: Avoid TCP_USER_TIMEOUT warning when explicitly specifying a non-epoll channel type to use (#​11564) (62f4098)
• okhttp: Don't warn about missing Conscrypt (6f35422). This is especially helpful when using TLS but not running on Android
• android: For UdsChannelBuilder, use fake IP instead of localhost (a908b5e). This avoids an unnecessary DNS lookup
• xds: Add xDS node ID in select control plane errors to enable cross-referencing with control plane logs when debugging (f3cf7c3)
• xds: Enhanced how ADS stream terminations are handled, specifically addressing cases where a response has or hasn't been received (#​2e9c3e19f)
• binder: Update status code documentation for Android 11's package visibility rules. (#​11551) (99be6e9)
• binder: Update binderDied() error description to spell out the possibilities for those unfamiliar with Android internals. (#​11628) (46c1b38)
• example-gauth: Use application default creds instead of file argument (#​11595) (94a0a0d)

Dependencies

• Updated protobuf-java to 3.25.5. This helps avoid CVE-2024-7254 (2ff837a)

Thanks to:
@​Juneezee
@​lgalfaso
@​bestbeforetoday
@​hlx502
@​JoeCqupt

v1.68.0: MISTAKE

Compare Source

This was supposed to be v1.67.0, but there was a mistake during the release process. This has everything in v1.67.1, except for:

• xds: Fix NullPointerException introduced in "Fix load reporting when pick first is used for locality-routing" (https://github.com/grpc/grpc-java/pull/11553)

v1.67.1

Compare Source

gRPC Java 1.67.1 Release Notes

There was no 1.67.0 release. There was a problem making the release and it went to Maven Central as 1.68.0 instead. This is a version-corrected release.

Improvements

• Petiole load balancing policies (e.g., round_robin, weighted_round_robin, ring_hash, least_request) had internal refactorings. This should not have changed their behavior
• api: Introduce onResult2 in NameResolver Listener2 that returns Status (90d0fab)
• core: touch() buffer when detach()ing (e821d5e). This makes it clearer whether a leak is a gRPC leak or an application leak when the Detachable API is being used
• example: delete duplicate and unused code in KeepAliveClient.java (6a9bc3b)
• example: Added Dualstack example (#​11451) (72a977b)
• stub: Add newAttachMetadataServerInterceptor() MetadataUtil (#​11458) (6dbd1b9)
• xds: Separate xds clients for each channel target, each with its own connection to an xds server. (#​11484) (d034a56)
• xds: Envoy proto sync to 2024-07-06 (#​11401) (96a788a)
• xds: cncf/xds proto sync to 2024-07-24 (#​11417) (0017c98)
• xds: Import RLQS protos (#​11418) (c29763d)
• xds: ClusterManagerLB must update child configuration (10d6002). Previously, RLS configuration would not have been updated

Bug Fixes

• core: Revert "Enable new PickFirst LB (#​11348)" (#​11425) (cc1cbe9)
• rls: Fix log statements incorrectly referring to "LRS" (#​11497) (c63e354)
• util: Stop using SocketAddress.toString() for checking address equality (f866c80). This change applies to all petiole load balancing policies. For regular usages that use dns name resolution, this is unlikely to matter as the default dns name resolver returns consistent addresses. But this might improve LB behavior for some custom load balancers
• xds: Fix load reporting when pick first is used for locality-routing. (#​11495) (1dae144)
• xds: Fix NullPointerException introduced in "Fix load reporting when pick first is used for locality-routing" (#​11553). This change is not present in 1.68.0
• xds: XdsClient should unsubscribe on last resource (#​11264) (448ec4f)

Dependencies

• Upgrade Netty to 4.1.110 and tcnative to 2.0.65 (#​11444) (70ae832)
• examples: Upgrade Maven plugin versions (75012a5)
• Remove direct dependency on j2objc (ff8e413)

Thanks to

@​Juneezee
@​lujiajing1126
@​JarvisCraft
@​sunpe

v1.66.0

Compare Source

gRPC Java 1.66.0 Release Notes

API Changes

• stub: Support setting onReadyThreshold through AbstractStub. (#​11320) (25a8b7c)
• util: Stabilize AdvancedTlsX509TrustManager, an X509ExtendedTrustManager that allows users to configure advanced TLS features, such as root certificate reloading and peer cert custom verification. (658cbf6)
• util: Align AdvancedTlsX509{Key and Trust}Manager. (#​11385)
• util: Add GracefulSwitchLoadBalancer config (ebed047) and mark switchTo() deprecated. (85e0a01). GracefulSwitchLoadBalancer now receives its configuration like a regular load balancer.
• binder: Introduce AllowSecurityPolicy to allow calling code to not have to wait on async/slow implementations. BinderTransport now submits async implementations to an executor. (#​11272) (7fee6a3)
• api: Add convenience method in ServerBuilder for adding a list of service implementations to the handler registry together. (#​11285) (85ed053)

Improvements

• examples: Improve example Bazel WORKSPACE to demonstrate referencing grpc-xds. (5ec0187)
• examples: Include Bazel bzlmod configuration (36e687f). There are now examples for both non-bzlmod and bzlmod.
• core: Fixes to PickFirstLeafLoadBalancer
  • Eliminate NPE after recovering from a temporary name resolution failure. (#​11298)
  • Deduplicate addresses. (#​11342, #​11345)
• core: Change default to use the new pick first load balancer (PickFirstLeafLoadBalancer). (#​11348)
• core: Use retryThrottling from defaultServiceConfig when the name resolver config doesn't provide this config. (#​11274) (062ebb4)
• netty: Enable use of Netty 4.1.111 by avoiding the optimization provided by NettyAdaptiveCumulator if Netty is on version 4.1.111 or later. (#​11367)
• binder: Set a default connect timeout of 60 seconds. (#​11359) (21dec30)
• binder: Make BinderServer own ServerAuthInterceptor's executor that helps avoid leaks. (#​11293) (15ad9f5)
• services:: Added ProtoReflectionServiceV1 for the v1 reflection protocol. The preexisting ProtoReflectionService implements the v1alpha reflection protocol. (#​11237) (0aa976c)

Bug Fixes

• binder: Add missing synchronization to prevent races when calling awaitTermination(). (#​11277) (14fd81f)
• util: Fix AdvancedTlsX509TrustManager validation on servers when using SSLSocket. Previously it would try to use a null SSLEngine . (dcb1c01)

Dependencies

• compiler: Upgrade from CentOS 7 to AlmaLinux 8 for the pre-compiled Linux protoc-gen-grpc-java (71eb5fb). This adds a runtime dependency on libstdc++
• Upgrade animal-sniffer-annotations to 1.24 (a977385)
• Upgrade error_prone_annotations to 2.28.0 (a977385)
• Upgrade proto-google-common-protos to 2.41.0 (a977385)
• Upgrade google-auth-library to 1.23.0 (a977385)
• Upgrade gson to 2.11.0 (a977385)
• Upgrade guava to 33.2.1 (a977385)
• Upgrade opentelemetry to 1.40.0 (a977385)
• Upgrade perfmark-api to 0.27.0 (a977385)
• Upgrade protobuf-java to 3.25.3 (a977385)
• xds: Remove unused opencensus-proto dependency (e7c3803)
• bazel: Replace @com_github_cncf_udpa usage with preexisting @com_github_cncf_xds; delete @com_github_cncf_udpa repo alias for xds (6dd6ca9)
• bazel: Upgrade envoyproxy/data-plane-api to 1611a73 (c540993). The version used by Gradle had been updated in 1.62.0 (68334a0), but the bazel version had not
• bazel: Use com_google_protobuf instead of com_google_protobuf_javalite (7a25e68). Bazel’s protobuf rules no longer use the old com_google_protobuf_javalite repository name
• bazel: Don't require protobuf to be in maven_install (d3c2f5a). Protobuf’s targets are generally just used directly; this fixed the only place that used maven’s artifact() syntax

Thanks to

@​hlx502
@​erm-g
@​jdcormie
@​JoaoVitorStein
@​cfredri4

v1.65.1

Compare Source

What's Changed

• netty: Restore old behavior of NettyAdaptiveCumulator, but avoid using that class if Netty is on version 4.1.111 or later

v1.65.0

Compare Source

grpc-netty in this release is compatible with Netty 4.1.111; it fixes the incompatibility that caused data corruption. grpc-netty-shaded is still using Netty 4.1.100.

New Features

• New module grpc-gcp-csm-observability (df8cfe9)

Improvements

• api: Add ClientStreamTracer.inboundHeaders(Metadata) (960012d). This is the same as the existing inboundHeaders(), but is provided the Metadata
• api: Fix various typos in the documentation (#​11144) (6ec744f)
• core: When queuing RPCs, don’t request picks from the LB twice (8844cf7). This could be viewed as a small performance optimization, but mainly reduces the amount of race-handling code
• util: Improve AdvancedTlsX509KeyManager’s documentation, verification, and testing. (#​11139) (781b4c4) This change shows @ExperimentalApi being removed, but it was re-added in 3c97245 before the release
• examples: Fix broken command in reflection readme (#​11131) (c31dbf4)
• binder: Add a connection timeout (#​11255) (791f894)

Bug fixes

• core: Exit idle mode when delayed transport is in use (fea577c). This was a long-standing race that could cause RPCs to hang, but was very unlikely to be hit. Avoiding the double-picking (8844cf7) made the race more visible
• netty: Fix Netty composite buffer merging to be compatible with Netty 4.1.111 (#​11294) (0fea7dd). The previous behavior easily caused data corruption
• okhttp: Workaround SSLSocket not noticing socket is closed (a28357e). Previously, shutting down when a new connection was being established could result in the server never becoming terminated
• inprocess: Fix listener race if transport is shutdown while starting (e4e7f3a). This issue was unlikely to be hit outside of specialized tests
• services: restore //services:binarylog bazel target (#​11292) (d57f271). This fixes a regression introduced in 1.62.2
• binder: Wait for all server transports to terminate before returning the security policy executor to the object pool (#​11240) (34ee600)
• binder: Reject further SETUP_TRANSPORT requests post-BinderServer shutdown (#​11260) (1670e97)
• bazel: Include missing com_google_protobuf_javalite in MODULE.bazel (#​11147) (f995c12)

Thanks to

@​hakusai22
@​firov
@​mateusazis
@​Mir3605
@​niloc132

v1.64.2

Compare Source

What's Changed

• netty: Restore old behavior of NettyAdaptiveCumulator, but avoid using that class if Netty is on version 4.1.111 or later

v1.64.1

Compare Source

What's Changed

• netty:Fix Netty composite buffer merging to be compatible with Netty 4.1.111 (1.64.x backport) by @​larry-safran in https://github.com/grpc/grpc-java/pull/11303

v1.64.0

Compare Source

Avoid upgrading your application to Netty 4.1.111, with this version as there is a possible corruption. For Netty 4.1.111 compatibility, it is best to use 1.63.2, 1.64.2, 1.65.1, and later. See https://github.com/grpc/grpc-java/issues/11284 .

API Changes

• compiler: the option jakarta_omit was renamed @generated=omit (#​11086) (8a21afc)

New Features

• New API LoadBalancer.getChannelTarget() (4561bb5)
• opentelemetry: Publish new module grpc-opentelemetry (5ba1a55). The feature is still missing documentation and an example. It only supports metrics; tracing and logs will be future enhancements. See gRFC A66
• bazel: Add support for bzlmod (#​11046) (d1890c0)
• bazel: Replace usages of the old compatibility maven targets with @maven targets (0064991)
• okhttp: Support serverBuilder.maxConcurrentCallsPerConnection (Fixes #​11062). (#​11063) (8050723)
• xds: Experimental metrics recording in WRR LB (06df25b, 35a171b, 2897b39), to be exported by grpc-opentelemetry if explicitly enabled in GrpcOpenTelemetry. See gRFC A78
• rls: Experimental metrics recording in RLS LB (a9fb272, a1d1932, 8133318), to be exported by grpc-opentelemetry if explicitly enabled in GrpcOpenTelemetry

Improvements

• examples: support bazel build for retry policy example (58de563)
• netty: Allow deframer errors to close stream with a status code, as long as headers have not yet been sent (e036b1b). This will greatly improve the debuggability of certain server errors in particular cases. Instead of the client seeing “CANCELLED: RST_STREAM closed stream. HTTP/2 error code: CANCEL”, they could see “RESOURCE_EXHAUSTED: gRPC message exceeds maximum size 4194304: 6144592”
• netty: Improve handling of unexpected write queue promise failures (#​11016)
• servlet: Avoid unnecessary FINEST hex string conversion by checking log level. Fixes #​11031. (f7ee5f3)
• StatusException/StatusRuntimeException hide stack trace in a simpler way (#​11064) (e36f099)
• util: Status desc for outlier detection ejection (#​11036) (10cb4a3)
• binder: Helper class to allow in process servers to use peer uids in test (#​11014) (537dbe8)
• Add load() statements for the Bazel builtin top-level java symbols (#​11105) (add8c37)
• Add StatusProto.toStatusException overload to accept Throwable (#​11083) (5c9b492)

Bug fixes

• Fix retry race condition that can lead to double decrementing inFlightSubStreams and so miss calling closed (#​11026) (bdb6230)
• Change defaults to use the older PickFirstLoadBalancer and disable Happy Eyeballs. This disables a performance optimization added in v1.63. (#​11120) We have had a report that the new implementation can trigger a NullPointerException
• core: Transition to CONNECTING immediately when exiting idle (2c5f0c2). Previously the visible state change from channel.getState() was delayed until the name resolver returned results. This had no impact to RPC behavior
• xds: Specify a locale for upper/lower case conversions (e630593)
• rls: Synchronization fixes in CachingRlsLbClient (6e97b18). These races had not been witnessed in practice
• rls: Guarantee backoff will update RLS picker (f9b6e5f). This fixes a regression introduced by 6e97b18 that could hang RPCs instead of using fallback, but fixes a pre-existing bug that could greatly delay RPCs from using fallback.
• rls: Fix time handling in CachingRlsLbClient (da619e2). This could have caused backoff entries to improperly be considered expired
• xds: Properly disable the default endpoint identification algorithm with XdsChannelCredentials (097a46b). The credential does its own verification and the default needs to be disabled for SPIFFE
• netty: Release SendGrpcFrameCommand when stream is missing (#​11116) (fb9a108)
• okhttp: Remove finished stream even if a pending stream was started (d21fe32)

Dependencies

• cronet: Update Cronet to latest release + Move to Stable Cronet APIs. (5a8da19)
• cronet: @​javadoc update android permission MODIFY_NETWORK_ACCOUNTING (deprecated) => UPDATE_DEVICE_STATS (c703a1e)
• cronet: Update to Java-8 API's and tighten the scopes (163efa3)
• cronet: Update to StandardCharsets and assertNotNull API's (77e59b2)

Acknowledgements

@​panchenko
@​Ashok-Varma
@​benjaminp
@​AutomatedTester
@​hypnoce
@​keith
@​laglangyue
@​rostik404
@​ryanpbrewster
@​abtom
@​hvadehra
@​rtadepalli

v1.63.2

Compare Source

What's Changed

• okhttp: Workaround SSLSocket not noticing socket is closed
• netty: skip using NettyAdaptiveCumulator when Netty is on version 4.1.111 or later

v1.63.1

Compare Source

Bug fixes

• netty: Release SendGrpcFrameCommand when stream is missing (#​11116) (fb9a108)
• Change defaults to use the older PickFirstLoadBalancer and disable Happy Eyeballs. This disables a performance optimization added in v1.63.0 (#​11120) We have had a report that the new implementation can trigger a NullPointerException